Skip to main content

Find a user by username

GET /api/v1/users/lookup/:username

Description​

Find a user by the username

Headers:

  • Content-Type: application/json
  • ApiKey: The platform api key is required to use this endpoint - {{platformApiKey}} URL: /api/v1/users/lookup/:username?tenantId=
  • ?tenantId=: This is an optional query parameter that allows you to filter the lookup based on a specific "tenantId." You should replace with the actual tenant ID you want to use for filtering. If you don't provide a tenant ID, the query parameter may be omitted.

Response: The response is "Created" with a code of 201.

/api/v1/users/lookup/:username?tenantId=<string>

Query Params​

Paramvalue
tenantIdstring

🔑 Authentication bearer​

ParamvalueType
tokenbearerTokenstring

Response: 200​

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /api/v1/users/lookup/:username \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!